Skip to content

[skip changelog] Move website versioning information out of CONTRIBUTING.md #1386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 11, 2021
Merged

[skip changelog] Move website versioning information out of CONTRIBUTING.md #1386

merged 2 commits into from
Aug 11, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 11, 2021

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • What kind of change does this PR introduce?

Docs update/fix

  • What is the current behavior?

This content is for maintainers, and is not of interest to the average contributor. It makes an already overly long
contributor guide even more overwhelming, and thus likely to be skipped.


Links in the contributor guide to documentation system assets were broken by changes to the file names during the sync to the "template" assets.

  • What is the new behavior?

The documentation versioning and publishing system is now maintained in a centralized repository hosting a collection of
reusable project assets. The documentation content previously located in CONTRIBUTING.md has all been migrated there and
expanded.

Since this is not high level contributor guidelines, it will be better to maintain it in a single place, linking to that
documentation as needed.


The remaining broken link is fixed.

No break

The GitHub Actions workflow used to deploy the documentation website was renamed to a filename more suitable for
existence in a collection of reusable workflows that have multiple variations according to project requirements.

The link to the file was not updated accordingly, which resulted it breaking.
…ING.md

This content is for maintainers, and is not of interest to the average contributor. It makes an already overly long
contributor guide even more overwhelming, and thus likely to be skipped.

The documentation versioning and publishing system is now maintained in a centralized repository hosting a collection of
reusable project assets. The documentation content previously located in CONTRIBUTING.md has all been migrated there and
expanded.

Since this is not high level contributor guidelines, it will be better to maintain it in a single place, linking to that
documentation as needed.
@per1234 per1234 added type: bug type: enhancement Proposed improvement topic: documentation Related to documentation for the project labels Aug 11, 2021
@per1234 per1234 merged commit 5bce623 into arduino:master Aug 11, 2021
@per1234 per1234 deleted the fix-links branch August 11, 2021 08:00
@rsora rsora added the type: imperfection Perceived defect in any part of project label Sep 22, 2021
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants